All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.symantec.itools.vcafe.openapi.pluginapi.Plugin

public interface Plugin

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

destroy()

Before Visual Cafe exits, this method is called for every initialized plugin.

getPluginInfo()

Plugin info.

init()

This method is called by the Visual Cafe framework, after it successfully loads a plugin class and create an instance of it.

restore(InputStream, boolean)

Plugin persistence.

save(OutputStream, boolean)

Plugin persistence.

public abstract void destroy()

Before Visual Cafe exits, this method is called for every initialized plugin. The plugin should not perform any action after this method is called. In particular, threads created by the plugin must be destroyed.

public abstract void getPluginInfo()

Plugin info. ** NOT YET IMPLEMENTED ** A place holder to obtain name, version and other info of a plugin.

public abstract void init()

This method is called by the Visual Cafe framework, after it successfully loads a plugin class and create an instance of it. Access to Visual Cafe open API is granted during this initialization.

public abstract void restore(InputStream is,
                             boolean local)

Plugin persistence. This method is called by the Visual Cafe framework when restoring workspace information from the disk. This could happen when a project is opened or Visual Cafe is started, or a workspace is switched. A plug in might want to read any state information it might have saved earlier

Parameters:

is - the input stream from which to read the data

b - true for local workspace and false for global workspace

public abstract void save(OutputStream os,
                          boolean local)

Plugin persistence. This method is called by the Visual Cafe framework when saving workspace information to the disk. This could happen when a project is closed or Visual Cafe is shutdown, or a workspace is switched. A plug in might want to save any state information it might have This information can be read back in the restore method when the framework loads the workspace.

Parameters:

os - the output stream to which data will be written

b - true for local workspace and false for global workspace

All Packages  Class Hierarchy  This Package  Previous  Next  Index